[core][doc] add actor+job+node event to ray event export doc#57930
Merged
can-anyscale merged 1 commit intomasterfrom Oct 25, 2025
Merged
[core][doc] add actor+job+node event to ray event export doc#57930can-anyscale merged 1 commit intomasterfrom
can-anyscale merged 1 commit intomasterfrom
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request adds documentation for actor, job, and node events to the Ray event export guide. The changes are clear and follow the existing structure of the document. I've provided a few suggestions to improve consistency and clarity in the descriptions of lifecycle events and to fix some minor formatting inconsistencies.
| For each actor, Ray exports two types of events: Actor Definition Event and Actor Lifecycle Event. | ||
| * Actor Definition Event contains the metadata of the actor when it is defined. | ||
| See `src/ray/protobuf/public/events_actor_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_actor_definition_event.proto>`_ for the event format. | ||
| * Actor Lifecycle Event contains the lifecycle information of the actor. |
Contributor
There was a problem hiding this comment.
The description for the Actor Lifecycle Event is a bit generic. To be more descriptive and consistent with the 'Task events' section, which mentions task state transition information, consider specifying that this event contains state transition information for actors.
Suggested change
| * Actor Lifecycle Event contains the lifecycle information of the actor. | |
| * Actor Lifecycle Event contains actor state transition information. |
| ^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| For each driver job, Ray exports two types of events: Driver Job Definition Event and Driver Job Lifecycle Event. | ||
|
|
Contributor
There was a problem hiding this comment.
There's an extra blank line here. For consistency with the other sections in this document (e.g., 'Task events' and 'Actor events'), please remove this blank line. A blank line is not needed between the introductory paragraph and the bulleted list.
|
|
||
| * Driver Job Definition Event contains the metadata of the driver job when it is defined. | ||
| See `src/ray/protobuf/public/events_driver_job_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_driver_job_definition_event.proto>`_ for the event format. | ||
| * Driver Job Lifecycle Event contains the lifecycle information of the driver job. |
Contributor
There was a problem hiding this comment.
Similar to the actor event, the description for the Driver Job Lifecycle Event is a bit generic. To improve clarity and consistency, consider specifying that it contains state transition information for driver jobs.
Suggested change
| * Driver Job Lifecycle Event contains the lifecycle information of the driver job. | |
| * Driver Job Lifecycle Event contains driver job state transition information. |
| ^^^^^^^^^^^ | ||
|
|
||
| For each node, Ray exports two types of events: Node Definition Event and Node Lifecycle Event. | ||
|
|
Contributor
There was a problem hiding this comment.
There's an extra blank line here. For consistency with the other sections in this document, please remove this blank line. A blank line is not needed between the introductory paragraph and the bulleted list.
|
|
||
| * Node Definition Event contains the metadata of the node when it is defined. | ||
| See `src/ray/protobuf/public/events_node_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_node_definition_event.proto>`_ for the event format. | ||
| * Node Lifecycle Event contains the lifecycle information of the node. |
Contributor
There was a problem hiding this comment.
Similar to the other lifecycle events, the description for the Node Lifecycle Event is a bit generic. To improve clarity and consistency, consider specifying that it contains state transition information for nodes.
Suggested change
| * Node Lifecycle Event contains the lifecycle information of the node. | |
| * Node Lifecycle Event contains node state transition information. |
can-anyscale
force-pushed
the
can-1ev09
branch
2 times, most recently
from
a9c21fa to
b8b7224
Compare
ray-gardener
bot
added
docs
angelinalg
approved these changes
Oct 22, 2025
Contributor
angelinalg
left a comment
angelinalg
left a comment
There was a problem hiding this comment.
Do you want to remove line 9 of the ray-event-export.rst file with these new features?
| Actor events | ||
| ^^^^^^^^^^^^ | ||
|
|
||
| For each actor, Ray exports two types of events: Actor Definition Event and Actor Lifecycle Event. |
Contributor
There was a problem hiding this comment.
Suggested change
| For each actor, Ray exports two types of events: Actor Definition Event and Actor Lifecycle Event. | |
| For each actor, Ray exports two types of events: Actor Definition Events and Actor Lifecycle Events. | |
Contributor
There was a problem hiding this comment.
Need a blank line before the bulleted points for it to render correctly.
| ^^^^^^^^^^^^ | ||
|
|
||
| For each actor, Ray exports two types of events: Actor Definition Event and Actor Lifecycle Event. | ||
| * Actor Definition Event contains the metadata of the actor when it is defined. See `src/ray/protobuf/public/events_actor_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_actor_definition_event.proto>`_ for the event format. |
Contributor
There was a problem hiding this comment.
Suggested change
| * Actor Definition Event contains the metadata of the actor when it is defined. See `src/ray/protobuf/public/events_actor_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_actor_definition_event.proto>`_ for the event format. | |
| * An Actor Definition Event contains the metadata of the actor when it's defined. See `src/ray/protobuf/public/events_actor_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_actor_definition_event.proto>`_ for the event format. |
|
|
||
| For each actor, Ray exports two types of events: Actor Definition Event and Actor Lifecycle Event. | ||
| * Actor Definition Event contains the metadata of the actor when it is defined. See `src/ray/protobuf/public/events_actor_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_actor_definition_event.proto>`_ for the event format. | ||
| * Actor Lifecycle Event contains the actor state transition information and metadata associated with each transition. See `src/ray/protobuf/public/events_actor_lifecycle_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_actor_lifecycle_event.proto>`_ for the event format. |
Contributor
There was a problem hiding this comment.
Suggested change
| * Actor Lifecycle Event contains the actor state transition information and metadata associated with each transition. See `src/ray/protobuf/public/events_actor_lifecycle_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_actor_lifecycle_event.proto>`_ for the event format. | |
| * An Actor Lifecycle Event contains the actor state transition information and metadata associated with each transition. See `src/ray/protobuf/public/events_actor_lifecycle_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_actor_lifecycle_event.proto>`_ for the event format. |
| Driver job events | ||
| ^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| For each driver job, Ray exports two types of events: Driver Job Definition Event and Driver Job Lifecycle Event. |
Contributor
There was a problem hiding this comment.
Suggested change
| For each driver job, Ray exports two types of events: Driver Job Definition Event and Driver Job Lifecycle Event. | |
| For each driver job, Ray exports two types of events: Driver Job Definition Events and Driver Job Lifecycle Events. |
|
|
||
| For each driver job, Ray exports two types of events: Driver Job Definition Event and Driver Job Lifecycle Event. | ||
|
|
||
| * Driver Job Definition Event contains the metadata of the driver job when it is defined. See `src/ray/protobuf/public/events_driver_job_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_driver_job_definition_event.proto>`_ for the event format. |
Contributor
There was a problem hiding this comment.
Suggested change
| * Driver Job Definition Event contains the metadata of the driver job when it is defined. See `src/ray/protobuf/public/events_driver_job_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_driver_job_definition_event.proto>`_ for the event format. | |
| * A Driver Job Definition Event contains the metadata of the driver job when it's defined. See `src/ray/protobuf/public/events_driver_job_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_driver_job_definition_event.proto>`_ for the event format. |
| For each driver job, Ray exports two types of events: Driver Job Definition Event and Driver Job Lifecycle Event. | ||
|
|
||
| * Driver Job Definition Event contains the metadata of the driver job when it is defined. See `src/ray/protobuf/public/events_driver_job_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_driver_job_definition_event.proto>`_ for the event format. | ||
| * Driver Job Lifecycle Event contains the driver job state transition information and metadata associated with each transition. See `src/ray/protobuf/public/events_driver_job_lifecycle_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_driver_job_lifecycle_event.proto>`_ for the event format. |
Contributor
There was a problem hiding this comment.
Suggested change
| * Driver Job Lifecycle Event contains the driver job state transition information and metadata associated with each transition. See `src/ray/protobuf/public/events_driver_job_lifecycle_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_driver_job_lifecycle_event.proto>`_ for the event format. | |
| * A Driver Job Lifecycle Event contains the driver job state transition information and metadata associated with each transition. See `src/ray/protobuf/public/events_driver_job_lifecycle_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_driver_job_lifecycle_event.proto>`_ for the event format. |
| Node events | ||
| ^^^^^^^^^^^ | ||
|
|
||
| For each node, Ray exports two types of events: Node Definition Event and Node Lifecycle Event. |
Contributor
There was a problem hiding this comment.
Suggested change
| For each node, Ray exports two types of events: Node Definition Event and Node Lifecycle Event. | |
| For each node, Ray exports two types of events: Node Definition Events and Node Lifecycle Events. |
|
|
||
| For each node, Ray exports two types of events: Node Definition Event and Node Lifecycle Event. | ||
|
|
||
| * Node Definition Event contains the metadata of the node when it is defined. See `src/ray/protobuf/public/events_node_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_node_definition_event.proto>`_ for the event format. |
Contributor
There was a problem hiding this comment.
Suggested change
| * Node Definition Event contains the metadata of the node when it is defined. See `src/ray/protobuf/public/events_node_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_node_definition_event.proto>`_ for the event format. | |
| * A Node Definition Event contains the metadata of the node when it's defined. See `src/ray/protobuf/public/events_node_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_node_definition_event.proto>`_ for the event format. |
| For each node, Ray exports two types of events: Node Definition Event and Node Lifecycle Event. | ||
|
|
||
| * Node Definition Event contains the metadata of the node when it is defined. See `src/ray/protobuf/public/events_node_definition_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_node_definition_event.proto>`_ for the event format. | ||
| * Node Lifecycle Event contains the node state transition information and metadata associated with each transition. See `src/ray/protobuf/public/events_node_lifecycle_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_node_lifecycle_event.proto>`_ for the event format. |
Contributor
There was a problem hiding this comment.
Suggested change
| * Node Lifecycle Event contains the node state transition information and metadata associated with each transition. See `src/ray/protobuf/public/events_node_lifecycle_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_node_lifecycle_event.proto>`_ for the event format. | |
| * A Node Lifecycle Event contains the node state transition information and metadata associated with each transition. See `src/ray/protobuf/public/events_node_lifecycle_event.proto <https://github.com/ray-project/ray/blob/master/src/ray/protobuf/public/events_node_lifecycle_event.proto>`_ for the event format. |
MengjinYan
reviewed
Oct 22, 2025
Contributor
There was a problem hiding this comment.
Nice! Can we add examples for the event types as well?
can-anyscale
force-pushed
the
can-1ev09
branch
from
b8b7224 to
a0f7ea6
Compare
Contributor
Author
|
address feedback |
can-anyscale
force-pushed
the
can-1ev09
branch
from
a0f7ea6 to
4d02729
Compare
Signed-off-by: Cuong Nguyen <can@anyscale.com>
can-anyscale
force-pushed
the
can-1ev09
branch
from
4d02729 to
4609149
Compare
xinyuangui2
pushed a commit
to xinyuangui2/ray
that referenced
this pull request
Oct 27, 2025
…ject#57930) Add actor+job+node event to ray event export doc Test: - CI Signed-off-by: Cuong Nguyen <can@anyscale.com> Signed-off-by: xgui <xgui@anyscale.com>
landscapepainter
pushed a commit
to landscapepainter/ray
that referenced
this pull request
Nov 17, 2025
…ject#57930) Add actor+job+node event to ray event export doc Test: - CI Signed-off-by: Cuong Nguyen <can@anyscale.com>
Aydin-ab
pushed a commit
to Aydin-ab/ray-aydin
that referenced
this pull request
Nov 19, 2025
…ject#57930) Add actor+job+node event to ray event export doc Test: - CI Signed-off-by: Cuong Nguyen <can@anyscale.com> Signed-off-by: Aydin Abiar <aydin@anyscale.com>
Future-Outlier
pushed a commit
to Future-Outlier/ray
that referenced
this pull request
Dec 7, 2025
…ject#57930) Add actor+job+node event to ray event export doc Test: - CI Signed-off-by: Cuong Nguyen <can@anyscale.com> Signed-off-by: Future-Outlier <eric901201@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add actor+job+node event to ray event export doc
Test: